<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilpuf: xpuf_mailbox.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilpuf
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xpuf__mailbox_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xpuf_mailbox.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains declarations of xilmailbox generic interface APIs. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.0   kpt  01/04/22 Initial release
      kpt  03/16/22 Removed IPI related code and added mailbox support
2.2   am   03/09/23 Moved payload length macros to xilmailbox.h file
      kal  09/14/23 Added XPuf_SetSlrIndex function
2.3   ng   11/22/23 Fixed doxygen grouping
2.4   ng   04/30/24 Fixed doxygen comments
2.5   obs  02/18/25 Fixed IPI message length</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a9fc9e137d33878bdfbca1d2a78610aee"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpuf__mailbox_8h.html#a9fc9e137d33878bdfbca1d2a78610aee">XPuf_SlrIndex</a> { , <a class="el" href="xpuf__mailbox_8h.html#a9fc9e137d33878bdfbca1d2a78610aeea4dc004920944c5c812793e3b1bc8fb38">XPUF_SLR_INDEX_1</a>,
<a class="el" href="xpuf__mailbox_8h.html#a9fc9e137d33878bdfbca1d2a78610aeea5adc7af257724bb66a3d8386d71dde78">XPUF_SLR_INDEX_2</a>,
<a class="el" href="xpuf__mailbox_8h.html#a9fc9e137d33878bdfbca1d2a78610aeeac927b2cdfaae2cfcb71553aa81863a7e">XPUF_SLR_INDEX_3</a>
 }</td></tr>
<tr class="memdesc:a9fc9e137d33878bdfbca1d2a78610aee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration constants for SlrIndex.  <a href="xpuf__mailbox_8h.html#a9fc9e137d33878bdfbca1d2a78610aee">More...</a><br/></td></tr>
<tr class="separator:a9fc9e137d33878bdfbca1d2a78610aee"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga2052fd116d6e086ca703c3518eafd887"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xpuf__mailbox__apis.html#ga2052fd116d6e086ca703c3518eafd887">XPuf_ProcessMailbox</a> (XMailbox *MailboxPtr, u32 *MsgPtr, u32 MsgLen)</td></tr>
<tr class="memdesc:ga2052fd116d6e086ca703c3518eafd887"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to the target module and gets the response from it.  <a href="group__xpuf__mailbox__apis.html#ga2052fd116d6e086ca703c3518eafd887">More...</a><br/></td></tr>
<tr class="separator:ga2052fd116d6e086ca703c3518eafd887"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a9fc9e137d33878bdfbca1d2a78610aee"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xpuf__mailbox_8h.html#a9fc9e137d33878bdfbca1d2a78610aee">XPuf_SlrIndex</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enumeration constants for SlrIndex. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a9fc9e137d33878bdfbca1d2a78610aeea4dc004920944c5c812793e3b1bc8fb38"></a>XPUF_SLR_INDEX_1</em>&nbsp;</td><td class="fielddoc">
<p>SLR_INDEX_0. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9fc9e137d33878bdfbca1d2a78610aeea5adc7af257724bb66a3d8386d71dde78"></a>XPUF_SLR_INDEX_2</em>&nbsp;</td><td class="fielddoc">
<p>SLR_INDEX_1. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a9fc9e137d33878bdfbca1d2a78610aeeac927b2cdfaae2cfcb71553aa81863a7e"></a>XPUF_SLR_INDEX_3</em>&nbsp;</td><td class="fielddoc">
<p>SLR_INDEX_2. </p>
<p>SLR_INDEX_3 </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
